Description | Example | Return Message | Group(s)

SCHED ApiReturnDataEnabled

Purpose

Enable or disable returning the data generated by an API command through a COM or socket interface.

Format

SCHED / ApiReturnDataEnabled {True | False}

Description

The SCHED ApiReturnDataEnabled Connect command enable or disables returning the data generated by an API command through a COM or socket interface. By default, this value is True.

This configuration item is not persisted (if desired to be false, it will need to be called during every instance of Scheduler.)

Example

SCHED / ApiReturnDataEnabled True

SyntaxExample
<CommandName>SCHED / ApiReturnDataEnabled
{True | False}True

Return Message

If activated, Connect returns an acknowledgment message.

Group Membership

This command belongs to the following group(s):

Scheduler

Version

11.1